-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add open source resources for docs #45
Conversation
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good! left a couple comments
@@ -1,23 +1,48 @@ | |||
# Nextra Docs Template | |||
## Quick Start | |||
Ensure you have `yarn` installed (macOS users can Run `brew install yarn`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the docs actually uses pnpm
instead of yarn
, can you update this?
also we'll need to update the github workflow above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh! I've been using yarn the whole time
Just updated with instructions for pnpm
For more information on how the docs are structured, please refer to the [Nextra docs](https://nextra.site/docs/guide). | ||
|
||
### Changing Content | ||
All content submitted will be reviewed by a maintainer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can u make sure that each PR requires at least one maintainer to review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a CODEOWNERS file to specify this, but will probably only take effect when it's merged into main
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
per discussion, let's just stick with yarn
instead otherwise looks good!
* style guide * workflow * test remove push * build * use pnpm instead * pnpm setup * version * add codeowners file * revert to yarn * edit link
Update README and Styleguide to encourage open source contributions
Add Github workflow to gate merging on validation (just simply building)